home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / rando093.arc / RANDO.DOC < prev    next >
Text File  |  1991-11-22  |  9KB  |  216 lines
  1.  
  2.     RANDO - RANDom Origin file maintenance
  3.  
  4.     Written by: Don Dawson, 1:141/730 @FidoNet            August, 1991
  5.  
  6.     This program is distributed under the Dinnerware concept.  You
  7.     might ask, what's Dinnerware?  You might know of Shareware and
  8.     Freeware.  The Dinnerware concept is this:  You don't owe me or
  9.     anyone else a thing if you choose to use this program.  However,
  10.     take your spouse, significant other, best friend or anyone
  11.     else you choose out to dinner.  You'll enjoy it, they'll enjoy it.
  12.  
  13.                              or
  14.     
  15.     Can't afford dinner?  Send a Thank You message to the person
  16.     that helped you set up your bbs or sent this program to you. It'll
  17.     only take a minute.
  18.  
  19.     THIS MATERIAL IS DISTRIBUTED "as is" WITHOUT ANY EXPRESSED OR
  20.     IMPLIED WARRANTY OR LIABILITY FOR DIRECT, INDIRECT OR
  21.     (IN)CONSEQUENTIAL DAMAGES.  If it breaks, you own ALL the parts.
  22.  
  23.     OVERVIEW:
  24.  
  25.     Why RANDO?  Rando will create random ORIGIN files in each of your
  26.     echomail areas.  Some message editors (MSGED for sure) and some FidoNet
  27.     BBS software (OPUS 1.70) will use this file to create a 'custom' origin
  28.     line instead of the same one in every echo.
  29.  
  30.     HOW IT WORKS:
  31.  
  32.     It will read a file (of up to 1000 lines) and randomly write an
  33.     ORIGIN (no extension) file into each echo area.  Passthru echo
  34.     areas are skipped (those with a # anywhere on the AREAS.BBS line).
  35.     Note:  See below if you don't have an AREAS.BBS file.
  36.     Of course, it reads the AREAS.BBS to find the path to each echomail
  37.     directory.  Creative and "what's an AREAS.BBS?" users please see below.
  38.         
  39.     Because "high bit" characters (greater than ASCII 127) are frowned
  40.     upon in any Zone 1 echomail, if the input file contains any such
  41.     characters the characters will be replaced with a + or a -.  Any lines
  42.     longer than 44 characters will be skipped and will be written to an
  43.     'error file' so you can either delete them or edit them to make the
  44.     lines shorter.  Why 44 characters?  Origin lines must be a single
  45.     line, multiple lines are not appreciated.  Allowing for the beginning
  46.     *Origin stuff and the ending (1:xxx/yyy@fidonet.org) 44 should do it.
  47.  
  48.     USING RANDO:
  49.  
  50.     You must provide two command line parameters, optionally five more,
  51.     seperated by a space (UPPER, lower or MiXeD case are ok).  If you
  52.     run it without anything on the command line you'll get something
  53.     like this:
  54.  
  55.           ╒════════════════════════════════════════════════════════╕
  56.           │            RANDO v.093 - Random Origin lines           │
  57.           │  (C) Copyright 1991 by Don Dawson 1:141/730.0@Fidonet  │
  58.           ╘════════════════════════════════════════════════════════╛
  59.  
  60.  
  61. Usage: [-a\path\filename] [-q\path\filename] [-e\path\filename]
  62.         [-x\path\filename] [-l] [-b] [-s]
  63.  
  64.   -a [path and file name of AREAS.BBS]
  65.      ex:. -ac:\misc\areas.bbs
  66.   -q [path and file name of quotes file]
  67.      ex:  -qc:\misc\quotes.lst
  68.   -e [path and file name of quotes error file] (optional)
  69.      ex:  -ec:\misc\rando.err
  70.   -x [path and file name of areas to eXclude (optional)
  71.      ex:  -xc:\misc\skipem.lst
  72.   -b BBS name from the AREAS.BBS file will be prefixed to the origin line.
  73.      ex:  -b
  74.   -s Run silently.
  75.      ex:  -s
  76.   -l Write rando.log containing \yourpath\ and each origin line.
  77.      ex:  -l
  78.    
  79.         . -A  the name and path to your AREAS.BBS file (required).
  80.  
  81.         . -Q  the name and path to the file that contains the stuff
  82.               (famous quotes?) you want to use in your *Origin line.
  83.               (required)
  84.  
  85.         . -E  the name and path to a file into which you'd like all
  86.               "errors" in your quote file written. (optional)
  87.  
  88.         . -X  the name and path to a file containing areas you would
  89.               like eXcluded from processing.  It must be in 'areas.bbs'
  90.               file format.  As a matter of fact, you can make a copy
  91.               of your areas.bbs file and delete or comment out the areas
  92.               that you want included.  Everything left in the file will
  93.               be excluded. (optional)
  94.  
  95.         . -B  This will prefix the contents of the origin file with your
  96.               BBS name.  The BBS name is the same one that's in your
  97.               areas.bbs (probably on the first line).  Everything up to
  98.               the '!' will be included. WARNING: Your BBS name must be
  99.               less than 44 characters.  If your BBS name + a randomly
  100.               selected line from the origin file is greater than 44 
  101.               characters, only your BBS name will be used for that origin
  102.               file. (optional)
  103.               
  104.         .  -S This will avoid displaying the paths to the origin line files
  105.               as the program runs.  The program will run a little quicker if
  106.               you use this. (optional)
  107.  
  108.         . -L  Log into RANDO.LOG each path and origin file contents.
  109.               (optional)
  110.  
  111.     EXAMPLES:
  112.  
  113.     rando -ac:\bbs\areas.bbs -qc:\bbs\quotes.txt -s
  114.  
  115.             Note: No trailing backslash following the file name.
  116.  
  117.     rando -ac:\misc\myareas.bbs -qd:\stuff\myorigin.bbs -ec:\junk\errors.lst
  118.  
  119.             This will write 'input file errors' to the ERRORS.LST file.
  120.  
  121.     rando -ac:\bbs\areas.bbs -qc:\bbs\quotes.txt -b
  122.     
  123.             Your BBS name will be prefixed to the contents of each origin
  124.             line in each ORIGIN file.
  125.  
  126.     CREATIVE USERS or "What's an areas.bbs"?
  127.     
  128.     An areas.bbs file looks like this:
  129.     
  130. Treasure Island ! Don Dawson
  131. f:\om\141STUFF  141STUFF        141/740 701
  132. f:\om\141SYSOP  141SYSOP        141/740 701
  133. f:\om\4DOS      4DOS            141/740 701
  134. f:\om\80XXX     80XXX           141/740 775
  135. f:\om\ANEWS     ANEWS  #        141/565 740 123/45
  136. #f:\om\ANIME    ANIME           141/740 701
  137.  
  138. The first line has the BBS name, a 'space ! space', sysop name.
  139. The following lines have \yourpath and the AREATAG.
  140. The # indicates a 'passthru' area.
  141.  
  142. RANDO is really only interested in one thing, the path to the directory
  143. into which to write the ORIGIN file.  If an area is 'passthru' (#), an
  144. ORIGIN file will not be created in that directory. Everything else is
  145. ignored.
  146.  
  147. If you want to be creative, you can do this:
  148.  
  149. Make two or more "fake areas.bbs" files, name them anything you want. For
  150. example: you might have a collection of origin lines that you want to use
  151. only in your sysop echos, another set in other echoes.  Run RANDO once for
  152. each group.  Like this:
  153.  
  154. For the sysop echoes:
  155.  
  156. rando -ac:\files\sysop.bbs -qc:\files\sysop.qte -s
  157. rando -ac:\files\others.bbs -qc:\files\other.qte -s
  158.  
  159.     Kudos to the Beta Testers:
  160.     
  161.     My thanks to the fine folks that took the risk and tested RANDO:
  162.     
  163.     Rob Schmaling, 141/765
  164.     Steve Plain,   141/980
  165.     Gary Snider,   141/740
  166.     Noel Smith,    141/945
  167.     Rudy Ramsey,   141/755
  168.     Paul Brazil,   141/710
  169.     Furlan Primus, 141/590
  170. ------------------------------------------------------------------------------
  171.  
  172. Revision History:
  173.  
  174. Version .01  5/25/91, the original
  175.         .02  5/26/91, made the display different
  176.         .03  5/28/91, added -x and -b options
  177.         .04  never released
  178.         .05  7/31/91, improved command line processing and an origin line
  179.              will not be repeated as long as there are at least the same
  180.              number (or more) of origin lines as there are areas.
  181.         .06  7/31/91, removed test code (OOPS!).  More 'error checking'
  182.              improvements.
  183.         .07  8/3/91, updated the docs.  Thanks to Gary Snider for the
  184.              "creative users" idea.
  185.              .  Documentation update.
  186.              .  It will now process files that contain '-' in the file
  187.                 name or path.
  188.              .  The 'errorfil' is renamed to rando.err.
  189.              .  Improved reporting of non-existent paths in the AREAS.BBS
  190.                 file.
  191.         .08  8/7/91, minor fixes:
  192.              . The RANDO.ERR file will only be created when there are
  193.                 errors instead of with every execution.  (Thanks Furlan!)
  194.              . Fixed a minor mite that would result in writing an empty
  195.                ORIGIN file if there were fewer quote lines than when there
  196.                were areas to write to.
  197.         .09  8/8/91, minor enhancement (requested):
  198.              . added -l command line option
  199.              . minor documentation fixes
  200.         .091 8/12/91, 2 mites fixed
  201.              . if -b was selected some long origin lines were not detected.
  202.              . the "error.log" is erased each time.
  203.         .092 8/13/91, minor enhancements
  204.              .  The rando.log is erased each run.
  205.              .  The -s (silent) and -l (log) options are now independent
  206.                 of each other.
  207.              .  The -l option no longer lists to the screen.
  208.              .  Minor doc updates.
  209.         .093 11/22/91
  210.              .  Will now skip Squish areas.  It looks for a $ in the path
  211.                 to an echo area.  Like this:
  212.                 
  213.                 $f:\om\AVIATION  AVIATION        141/740
  214.                 
  215.                 ORIGIN in not supported in Maximus 2.0 <sigh>
  216.